PR Summary

This pull request introduces two main enhancements to the validmind library:

1. Summary Truncation: A new function _truncate_summary has been added to handle the truncation of summaries that exceed a specified token limit. This function uses the tiktoken library to encode the summary and ensure it does not exceed the max_tokens limit. If the summary is too long, it truncates the middle part and appends a truncation notice.

2. Enhanced Error Handling: The error handling in the generate_description function has been improved. Specifically, when an exception occurs due to the maximum context length being exceeded, a warning is logged, and a default description is used. This change provides more informative logging and ensures that the system can gracefully handle large test results without failing.

These changes aim to improve the robustness and usability of the description generation process in the validmind library.

Test Suggestions

• Test the _truncate_summary function with summaries of varying lengths to ensure it correctly truncates when necessary.
• Verify that the generate_description function logs appropriate warnings and uses default descriptions when the maximum context length is exceeded.
• Check the integration of tiktoken to ensure it encodes and decodes summaries correctly.
• Ensure that existing functionality in generate_description is not affected by the new error handling logic.

PR Summary

This pull request introduces a new function _truncate_summary in the validmind/ai/test_descriptions.py file to handle cases where the summary of a test description exceeds a specified maximum token length. The function uses the tiktoken library to encode the summary and truncate it if necessary, ensuring that the summary does not exceed the max_tokens limit. If truncation occurs, a warning is logged, and the summary is truncated with a note indicating the truncation.

Additionally, the generate_description function has been updated to use _truncate_summary for the summary field, ensuring that the generated descriptions adhere to context length restrictions. The error handling in the wrapped function has also been improved to provide more specific warnings when a test result is too large to generate a description.

Test Suggestions

• Test the _truncate_summary function with summaries of varying lengths to ensure it correctly truncates when necessary.
• Verify that the generate_description function correctly integrates _truncate_summary and handles summaries exceeding the maximum token length.
• Check that appropriate warnings are logged when a summary is truncated or when a test result is too large.
• Ensure that the default description is used when an exception occurs in generate_description.